<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.math.analysis.integration;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import org.apache.commons.math.ConvergingAlgorithmImpl;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.apache.commons.math.MathRuntimeException;<a name="line.20"></a>
<FONT color="green">021</FONT>    import org.apache.commons.math.analysis.UnivariateRealFunction;<a name="line.21"></a>
<FONT color="green">022</FONT>    <a name="line.22"></a>
<FONT color="green">023</FONT>    /**<a name="line.23"></a>
<FONT color="green">024</FONT>     * Provide a default implementation for several generic functions.<a name="line.24"></a>
<FONT color="green">025</FONT>     *  <a name="line.25"></a>
<FONT color="green">026</FONT>     * @version $Revision: 799857 $ $Date: 2009-08-01 09:07:12 -0400 (Sat, 01 Aug 2009) $<a name="line.26"></a>
<FONT color="green">027</FONT>     * @since 1.2<a name="line.27"></a>
<FONT color="green">028</FONT>     */<a name="line.28"></a>
<FONT color="green">029</FONT>    public abstract class UnivariateRealIntegratorImpl<a name="line.29"></a>
<FONT color="green">030</FONT>        extends ConvergingAlgorithmImpl implements UnivariateRealIntegrator {<a name="line.30"></a>
<FONT color="green">031</FONT>    <a name="line.31"></a>
<FONT color="green">032</FONT>        /** Serializable version identifier. */<a name="line.32"></a>
<FONT color="green">033</FONT>        private static final long serialVersionUID = 6248808456637441533L;<a name="line.33"></a>
<FONT color="green">034</FONT>    <a name="line.34"></a>
<FONT color="green">035</FONT>        /** minimum number of iterations */<a name="line.35"></a>
<FONT color="green">036</FONT>        protected int minimalIterationCount;<a name="line.36"></a>
<FONT color="green">037</FONT>    <a name="line.37"></a>
<FONT color="green">038</FONT>        /** default minimum number of iterations */<a name="line.38"></a>
<FONT color="green">039</FONT>        protected int defaultMinimalIterationCount;<a name="line.39"></a>
<FONT color="green">040</FONT>    <a name="line.40"></a>
<FONT color="green">041</FONT>        /** indicates whether an integral has been computed */<a name="line.41"></a>
<FONT color="green">042</FONT>        protected boolean resultComputed = false;<a name="line.42"></a>
<FONT color="green">043</FONT>    <a name="line.43"></a>
<FONT color="green">044</FONT>        /** the last computed integral */<a name="line.44"></a>
<FONT color="green">045</FONT>        protected double result;<a name="line.45"></a>
<FONT color="green">046</FONT>    <a name="line.46"></a>
<FONT color="green">047</FONT>        /** The integrand functione.<a name="line.47"></a>
<FONT color="green">048</FONT>         * @deprecated as of 2.0 the integrand function is passed as an argument<a name="line.48"></a>
<FONT color="green">049</FONT>         * to the {@link #integrate(UnivariateRealFunction, double, double)}method. */<a name="line.49"></a>
<FONT color="green">050</FONT>        @Deprecated<a name="line.50"></a>
<FONT color="green">051</FONT>        protected UnivariateRealFunction f;<a name="line.51"></a>
<FONT color="green">052</FONT>    <a name="line.52"></a>
<FONT color="green">053</FONT>        /**<a name="line.53"></a>
<FONT color="green">054</FONT>         * Construct an integrator with given iteration count and accuracy.<a name="line.54"></a>
<FONT color="green">055</FONT>         * <a name="line.55"></a>
<FONT color="green">056</FONT>         * @param f the integrand function<a name="line.56"></a>
<FONT color="green">057</FONT>         * @param defaultMaximalIterationCount maximum number of iterations<a name="line.57"></a>
<FONT color="green">058</FONT>         * @throws IllegalArgumentException if f is null or the iteration<a name="line.58"></a>
<FONT color="green">059</FONT>         * limits are not valid<a name="line.59"></a>
<FONT color="green">060</FONT>         * @deprecated as of 2.0 the integrand function is passed as an argument<a name="line.60"></a>
<FONT color="green">061</FONT>         * to the {@link #integrate(UnivariateRealFunction, double, double)}method.<a name="line.61"></a>
<FONT color="green">062</FONT>         */<a name="line.62"></a>
<FONT color="green">063</FONT>        @Deprecated<a name="line.63"></a>
<FONT color="green">064</FONT>        protected UnivariateRealIntegratorImpl(final UnivariateRealFunction f,<a name="line.64"></a>
<FONT color="green">065</FONT>                                               final int defaultMaximalIterationCount)<a name="line.65"></a>
<FONT color="green">066</FONT>            throws IllegalArgumentException {<a name="line.66"></a>
<FONT color="green">067</FONT>            super(defaultMaximalIterationCount, 1.0e-15);<a name="line.67"></a>
<FONT color="green">068</FONT>            if (f == null) {<a name="line.68"></a>
<FONT color="green">069</FONT>                throw MathRuntimeException.createIllegalArgumentException("function is null");<a name="line.69"></a>
<FONT color="green">070</FONT>            }<a name="line.70"></a>
<FONT color="green">071</FONT>    <a name="line.71"></a>
<FONT color="green">072</FONT>            this.f = f;<a name="line.72"></a>
<FONT color="green">073</FONT>    <a name="line.73"></a>
<FONT color="green">074</FONT>            // parameters that are problem specific<a name="line.74"></a>
<FONT color="green">075</FONT>            setRelativeAccuracy(1.0e-6);<a name="line.75"></a>
<FONT color="green">076</FONT>            this.defaultMinimalIterationCount = 3;<a name="line.76"></a>
<FONT color="green">077</FONT>            this.minimalIterationCount = defaultMinimalIterationCount;<a name="line.77"></a>
<FONT color="green">078</FONT>            <a name="line.78"></a>
<FONT color="green">079</FONT>            verifyIterationCount();<a name="line.79"></a>
<FONT color="green">080</FONT>        }<a name="line.80"></a>
<FONT color="green">081</FONT>    <a name="line.81"></a>
<FONT color="green">082</FONT>        /**<a name="line.82"></a>
<FONT color="green">083</FONT>         * Construct an integrator with given iteration count and accuracy.<a name="line.83"></a>
<FONT color="green">084</FONT>         * <a name="line.84"></a>
<FONT color="green">085</FONT>         * @param defaultMaximalIterationCount maximum number of iterations<a name="line.85"></a>
<FONT color="green">086</FONT>         * @throws IllegalArgumentException if f is null or the iteration<a name="line.86"></a>
<FONT color="green">087</FONT>         * limits are not valid<a name="line.87"></a>
<FONT color="green">088</FONT>         */<a name="line.88"></a>
<FONT color="green">089</FONT>        protected UnivariateRealIntegratorImpl(final int defaultMaximalIterationCount)<a name="line.89"></a>
<FONT color="green">090</FONT>            throws IllegalArgumentException {<a name="line.90"></a>
<FONT color="green">091</FONT>            super(defaultMaximalIterationCount, 1.0e-15);<a name="line.91"></a>
<FONT color="green">092</FONT>    <a name="line.92"></a>
<FONT color="green">093</FONT>            // parameters that are problem specific<a name="line.93"></a>
<FONT color="green">094</FONT>            setRelativeAccuracy(1.0e-6);<a name="line.94"></a>
<FONT color="green">095</FONT>            this.defaultMinimalIterationCount = 3;<a name="line.95"></a>
<FONT color="green">096</FONT>            this.minimalIterationCount = defaultMinimalIterationCount;<a name="line.96"></a>
<FONT color="green">097</FONT>            <a name="line.97"></a>
<FONT color="green">098</FONT>            verifyIterationCount();<a name="line.98"></a>
<FONT color="green">099</FONT>        }<a name="line.99"></a>
<FONT color="green">100</FONT>    <a name="line.100"></a>
<FONT color="green">101</FONT>        /**<a name="line.101"></a>
<FONT color="green">102</FONT>         * Access the last computed integral.<a name="line.102"></a>
<FONT color="green">103</FONT>         * <a name="line.103"></a>
<FONT color="green">104</FONT>         * @return the last computed integral<a name="line.104"></a>
<FONT color="green">105</FONT>         * @throws IllegalStateException if no integral has been computed<a name="line.105"></a>
<FONT color="green">106</FONT>         */<a name="line.106"></a>
<FONT color="green">107</FONT>        public double getResult() throws IllegalStateException {<a name="line.107"></a>
<FONT color="green">108</FONT>            if (resultComputed) {<a name="line.108"></a>
<FONT color="green">109</FONT>                return result;<a name="line.109"></a>
<FONT color="green">110</FONT>            } else {<a name="line.110"></a>
<FONT color="green">111</FONT>                throw MathRuntimeException.createIllegalStateException("no result available");<a name="line.111"></a>
<FONT color="green">112</FONT>            }<a name="line.112"></a>
<FONT color="green">113</FONT>        }<a name="line.113"></a>
<FONT color="green">114</FONT>    <a name="line.114"></a>
<FONT color="green">115</FONT>        /**<a name="line.115"></a>
<FONT color="green">116</FONT>         * Convenience function for implementations.<a name="line.116"></a>
<FONT color="green">117</FONT>         * <a name="line.117"></a>
<FONT color="green">118</FONT>         * @param result the result to set<a name="line.118"></a>
<FONT color="green">119</FONT>         * @param iterationCount the iteration count to set<a name="line.119"></a>
<FONT color="green">120</FONT>         */<a name="line.120"></a>
<FONT color="green">121</FONT>        protected final void setResult(double result, int iterationCount) {<a name="line.121"></a>
<FONT color="green">122</FONT>            this.result = result;<a name="line.122"></a>
<FONT color="green">123</FONT>            this.iterationCount = iterationCount;<a name="line.123"></a>
<FONT color="green">124</FONT>            this.resultComputed = true;<a name="line.124"></a>
<FONT color="green">125</FONT>        }<a name="line.125"></a>
<FONT color="green">126</FONT>    <a name="line.126"></a>
<FONT color="green">127</FONT>        /**<a name="line.127"></a>
<FONT color="green">128</FONT>         * Convenience function for implementations.<a name="line.128"></a>
<FONT color="green">129</FONT>         */<a name="line.129"></a>
<FONT color="green">130</FONT>        protected final void clearResult() {<a name="line.130"></a>
<FONT color="green">131</FONT>            this.iterationCount = 0;<a name="line.131"></a>
<FONT color="green">132</FONT>            this.resultComputed = false;<a name="line.132"></a>
<FONT color="green">133</FONT>        }<a name="line.133"></a>
<FONT color="green">134</FONT>    <a name="line.134"></a>
<FONT color="green">135</FONT>        /** {@inheritDoc} */<a name="line.135"></a>
<FONT color="green">136</FONT>        public void setMinimalIterationCount(int count) {<a name="line.136"></a>
<FONT color="green">137</FONT>            minimalIterationCount = count;<a name="line.137"></a>
<FONT color="green">138</FONT>        }<a name="line.138"></a>
<FONT color="green">139</FONT>    <a name="line.139"></a>
<FONT color="green">140</FONT>        /** {@inheritDoc} */<a name="line.140"></a>
<FONT color="green">141</FONT>        public int getMinimalIterationCount() {<a name="line.141"></a>
<FONT color="green">142</FONT>            return minimalIterationCount;<a name="line.142"></a>
<FONT color="green">143</FONT>        }<a name="line.143"></a>
<FONT color="green">144</FONT>    <a name="line.144"></a>
<FONT color="green">145</FONT>        /** {@inheritDoc} */<a name="line.145"></a>
<FONT color="green">146</FONT>        public void resetMinimalIterationCount() {<a name="line.146"></a>
<FONT color="green">147</FONT>            minimalIterationCount = defaultMinimalIterationCount;<a name="line.147"></a>
<FONT color="green">148</FONT>        }<a name="line.148"></a>
<FONT color="green">149</FONT>    <a name="line.149"></a>
<FONT color="green">150</FONT>        /**<a name="line.150"></a>
<FONT color="green">151</FONT>         * Verifies that the endpoints specify an interval.<a name="line.151"></a>
<FONT color="green">152</FONT>         * <a name="line.152"></a>
<FONT color="green">153</FONT>         * @param lower lower endpoint<a name="line.153"></a>
<FONT color="green">154</FONT>         * @param upper upper endpoint<a name="line.154"></a>
<FONT color="green">155</FONT>         * @throws IllegalArgumentException if not interval<a name="line.155"></a>
<FONT color="green">156</FONT>         */<a name="line.156"></a>
<FONT color="green">157</FONT>        protected void verifyInterval(double lower, double upper) throws<a name="line.157"></a>
<FONT color="green">158</FONT>            IllegalArgumentException {<a name="line.158"></a>
<FONT color="green">159</FONT>            if (lower &gt;= upper) {<a name="line.159"></a>
<FONT color="green">160</FONT>                throw MathRuntimeException.createIllegalArgumentException(<a name="line.160"></a>
<FONT color="green">161</FONT>                        "endpoints do not specify an interval: [{0}, {1}]",<a name="line.161"></a>
<FONT color="green">162</FONT>                        lower, upper);<a name="line.162"></a>
<FONT color="green">163</FONT>            }       <a name="line.163"></a>
<FONT color="green">164</FONT>        }<a name="line.164"></a>
<FONT color="green">165</FONT>    <a name="line.165"></a>
<FONT color="green">166</FONT>        /**<a name="line.166"></a>
<FONT color="green">167</FONT>         * Verifies that the upper and lower limits of iterations are valid.<a name="line.167"></a>
<FONT color="green">168</FONT>         * <a name="line.168"></a>
<FONT color="green">169</FONT>         * @throws IllegalArgumentException if not valid<a name="line.169"></a>
<FONT color="green">170</FONT>         */<a name="line.170"></a>
<FONT color="green">171</FONT>        protected void verifyIterationCount() throws IllegalArgumentException {<a name="line.171"></a>
<FONT color="green">172</FONT>            if ((minimalIterationCount &lt;= 0) || (maximalIterationCount &lt;= minimalIterationCount)) {<a name="line.172"></a>
<FONT color="green">173</FONT>                throw MathRuntimeException.createIllegalArgumentException(<a name="line.173"></a>
<FONT color="green">174</FONT>                        "invalid iteration limits: min={0}, max={1}",<a name="line.174"></a>
<FONT color="green">175</FONT>                        minimalIterationCount, maximalIterationCount);<a name="line.175"></a>
<FONT color="green">176</FONT>            }       <a name="line.176"></a>
<FONT color="green">177</FONT>        }<a name="line.177"></a>
<FONT color="green">178</FONT>    }<a name="line.178"></a>




























































</PRE>
</BODY>
</HTML>
